Skip to content

Introduce configurable timeout to Create NAS backup#12964

Open
abh1sar wants to merge 4 commits intoapache:4.22from
shapeblue:backup-timeout
Open

Introduce configurable timeout to Create NAS backup#12964
abh1sar wants to merge 4 commits intoapache:4.22from
shapeblue:backup-timeout

Conversation

@abh1sar
Copy link
Copy Markdown
Contributor

@abh1sar abh1sar commented Apr 6, 2026

Description

Create backup used to take the default cmds.timeout (7200s) in agent.properties as the timeout.
This might not be enough for large images and slow networks.
Adding a configurable timeout for create backup.

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • Build/CI
  • Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

How Has This Been Tested?

  1. Decreased timeout to 10s
  2. Backup failed
  3. Increased timeout to 300
  4. Backup was taken successfully

How did you try to break this feature and the system with this change?

@abh1sar abh1sar added this to the 4.22.1 milestone Apr 6, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 6, 2026 •
edited
Loading

Codecov Report

❌ Patch coverage is 20.00000% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.60%. Comparing base (59b6c32) to head (21b8b1a).
⚠️ Report is 3 commits behind head on 4.22.

Files with missing lines Patch % Lines
...ce/wrapper/LibvirtRestoreBackupCommandWrapper.java 33.33% 1 Missing and 1 partial ⚠️
...ource/wrapper/LibvirtTakeBackupCommandWrapper.java 0.00% 2 Missing ⚠️
Additional details and impacted files 
@@             Coverage Diff              @@
##               4.22   #12964      +/-   ##
============================================
- Coverage     17.60%   17.60%   -0.01%     
+ Complexity    15676    15675       -1     
============================================
  Files          5918     5918              
  Lines        531667   531682      +15     
  Branches      65001    65007       +6     
============================================
- Hits          93617    93615       -2     
- Misses       427491   427506      +15     
- Partials      10559    10561       +2
Flag Coverage Δ
uitests 3.70% <ø> (ø)
unittests 18.67% <20.00%> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@abh1sar
Copy link
Copy Markdown
Contributor Author

abh1sar commented Apr 6, 2026

@blueorangutan package

@blueorangutan
Copy link
Copy Markdown

blueorangutan commented Apr 6, 2026

@abh1sar a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress.

sureshanaparti
sureshanaparti reviewed Apr 6, 2026
View reviewed changes
plugins/backup/nas/src/main/java/org/apache/cloudstack/backup/NASBackupProvider.java Outdated
@@ -211,6 +212,7 @@ public Pair<Boolean, Backup> takeBackup(final VirtualMachine vm, Boolean quiesce
command.setBackupRepoAddress(backupRepository.getAddress());
command.setMountOptions(backupRepository.getMountOptions());
command.setQuiesce(quiesceVM);
command.setTimeout(NASBackupCreateBackupTimeout.value());
Copy link
Copy Markdown
Contributor

@sureshanaparti sureshanaparti Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@abh1sar can this be addressed with the value 'TakeBackupCommand=14400' in commands.timeout global config? if so, we can document it and skip this new timeout config?

Copy link
Copy Markdown
Contributor Author

@abh1sar abh1sar Apr 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sureshanaparti . I'll test with commands.timeout and update

Copy link
Copy Markdown
Contributor Author

@abh1sar abh1sar Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sureshanaparti made the change to use commands.timeout. default value is taken from libvirtComputingResource.getCmdsTimeout() if commands.timeout is not set, as before.

@abh1sar abh1sar changed the base branch from main to 4.22 April 6, 2026 12:57
@blueorangutan
Copy link
Copy Markdown

blueorangutan commented Apr 6, 2026

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17365

sureshanaparti
sureshanaparti approved these changes Apr 7, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@sureshanaparti sureshanaparti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

clgtm

@sureshanaparti
Copy link
Copy Markdown
Contributor

sureshanaparti commented Apr 7, 2026

@blueorangutan package

@blueorangutan
Copy link
Copy Markdown

blueorangutan commented Apr 7, 2026

@sureshanaparti a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

@sureshanaparti sureshanaparti moved this from Todo to In Progress in Apache CloudStack 4.22.1 Apr 7, 2026
@sureshanaparti sureshanaparti requested a review from Copilot April 7, 2026 06:35
Copilot AI reviewed Apr 7, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a configurable timeout for KVM NAS backup/restore operations by deriving a per-command timeout (with fallback to the agent default), and updates unit tests accordingly.

Changes:

  • Compute an effective timeout from command.getWait() (fallback to cmds.timeout) for TakeBackupCommand.
  • Apply the same effective timeout strategy to restore flows and propagate it to rsync and qemu-img execution.
  • Adjust LibvirtRestoreBackupCommandWrapperTest static script stubbing to better simulate rsync outcomes.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.

File Description
plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtTakeBackupCommandWrapper.java Uses per-command timeout (from wait) when executing piped backup commands.
plugins/hypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapper.java Applies per-command timeout to rsync and qemu-img restore operations.
plugins/hypervisors/kvm/src/test/java/com/cloud/hypervisor/kvm/resource/wrapper/LibvirtRestoreBackupCommandWrapperTest.java Updates script mocks to model different exit codes (e.g., rsync failure) and simplifies one test’s stubbing.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@blueorangutan
Copy link
Copy Markdown

blueorangutan commented Apr 7, 2026

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 17382

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@sureshanaparti sureshanaparti sureshanaparti approved these changes

Assignees

No one assigned

Labels

component:backup component:kvm status:needs-testing

Projects

Apache CloudStack 4.22.1
Status: In Progress

Milestone

4.22.1

Development

Successfully merging this pull request may close these issues.

4 participants

@abh1sar @blueorangutan @sureshanaparti